Skip to content

docs(education): add your-first-skill beginner on-ramp#715

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-your-first-skill
Jul 4, 2026
Merged

docs(education): add your-first-skill beginner on-ramp#715
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-your-first-skill

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Zero-to-merged path for landing a first working skill in the maintainer-education stream. Covers:

  • How skills differ from traditional code (probabilistic, eval-based)
  • Step 0–6 from scaffold to merged PR
  • Eval suite requirement with fixture structure
  • Common first-time mistakes (executes-not-proposes, baked project names, single happy-path fixture, skipping the validator)
  • Cross-link to write-skill authoring reference (the existing skill for contributors who already know the shape)
  • Updates the docs/education/README.md index with a live link
  • Adds education/ to docs/index.md "Where to go next" table

Generated-by: Claude (Opus 4.7)

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other:

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:

Zero-to-merged walkthrough for landing a first skill, and flip its row in
the education index to a live link.

Generated-by: Claude Code (Opus 4.8)
@potiuk potiuk force-pushed the education-your-first-skill branch from 5751fef to e836112 Compare July 4, 2026 16:58

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed after rebase onto main (post-#713). Now a minimal diff: adds docs/education/your-first-skill.md and flips its row in the canonical education README to a live link + Ready — no competing README, no duplicate docs/index.md line. Links resolve (magpie-write-skill, init_skill.py, skill-evals, MISSION/PRINCIPLES/CONTRIBUTING); the two apache/airflow mentions are deliberate "don't do this" anti-examples, not baked-in values. lychee clean, no emojis, placeholder-clean. LGTM.

@potiuk potiuk merged commit 991240c into apache:main Jul 4, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants